home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr44 / sndoff20.zip / SOUNDOFF.DOC < prev    next >
Text File  |  1993-04-07  |  19KB  |  452 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                  SOUND OFF!
  9.  
  10.                                 Version 2.0
  11.  
  12.                         Command Line and Batch File
  13.                           Sound Production Center
  14.  
  15.  
  16.                        (C) Copyright 1992 Rand Nowell
  17.                              RaLin Enterprises
  18.                         "Putting Bits Together" (tm)
  19.  
  20.  
  21.                         ┌───── PROGRAM MANUAL ─────┐
  22.                         │     August 26, 1992      │
  23.                         └──────────────────────────┘
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.                             - MANUAL CONTENTS -
  31.  
  32.                   LEGAL STUFF...........................i
  33.                   OVERVIEW..............................1
  34.                   SYSTEM REQUIREMENTS...................1
  35.                   COMMAND SYNTAX........................1
  36.                     Minimum Variables...................1
  37.                   DISPLAY SCREEN......................2,3
  38.                   SCRIPT FILE COMMENTS..................3
  39.                   SWITCHES..........................2,3,4
  40.                       (/f) & (/fs) Sound Script.........2
  41.                       (/s) No Display...................3
  42.                       (/m) & (/ms) Music Script.........3
  43.                       (/a) & (/a2) Alarms...............4
  44.                       (/k) Kill Sound...................4
  45.                   ERRORCODES............................4
  46.                   FILE PLACEMENT........................4
  47.                   SHAREWARE MESSAGES....................4
  48.                   REGISTRATION, WHY.....................5
  49.                   DISTRIBUTION..........................5
  50.                   AUTHOR CONTACT......................5,6
  51.                   SUPPORT...............................6
  52.                   ACKNOWLADGEMENTS......................6
  53.  
  54.    Copyright:                                                    i
  55.  
  56.    Sound Off!, the program and documentation,
  57.    is not a Public Domain or Free program. It is the
  58.    Copyrighted (C)1992 work of Rand Nowell dba Ralin Enterprises.
  59.    All rights are reserved. Copying, duplicating, selling or otherwise
  60.    distributing this product except as noted in the Distribution Policy
  61.    below is a violation of Federal Copyright Law.
  62.  
  63.  
  64.    Distribution:
  65.  
  66.    1. Feel free to distribute the Shareware version of this program as
  67.       often as you like to any interested parties. Distribution to
  68.       Electronic Bullentin Boards is encouraged.
  69.    2. Please do not distribute this program without all the original
  70.       related files such as documentation, readme files, registration
  71.       forms etc.
  72.    3. Please distribute ONLY the original authenticated ZIP format file.
  73.    4. Please obtain our written permission before including the program
  74.       with any "bundled" software packages.
  75.    5. Please do not accept payment for the program; a copying fee of
  76.       $5.00 per diskette may be charged by a non-profit user-group.
  77.    6. Please do not alter the program or documentation in any way.
  78.    7. Individuals, groups, vendors or other software distribution
  79.       companies which market diskettes containg shareware or test-drive
  80.       evaluation programs, for profit, must obtain written permission
  81.       from RaLin Enterprises prior to distribution.
  82.  
  83.     ************************* DISCLAIMER *****************************
  84.  
  85.     This program is supplied "as is" without warrenty of any kind. The
  86.     entire risk of using, and results from the use of, is assumed by you
  87.     the user.  You assume all costs of repair, servicing and corrections
  88.     stemming from the use of this program.
  89.     Rand Nowell and/or RaLin Enterprises, or any other associated
  90.     company of the program author will not be held liable for any
  91.     damages from the use of this program. No warrenties are expressed or
  92.     implied.
  93.     ********************************************************************
  94.     To the original licensee of the REGISTERD version of The Program
  95.     RaLin Enterprises DOES warrant that the program disk(s) on which the
  96.     program is recorded, be free from defects in material and
  97.     workmanship under normal use and service for a period of (90) ninety
  98.     days from date of delivery as evidenced by your receipt. Our entire
  99.     liability and your exclusive remedy shall be replacement of the
  100.     deffective disk not meeting the standards of this limited warranty.
  101.     And in no case shall exceed the cost of reimbursment of monies paid for
  102.     program registration.
  103.  
  104.  
  105.   
  106. Sound Off!          Sound Generator - Program Documentation         Page   1
  107.  
  108. OVERVIEW:
  109.  
  110.    Sound Off! can be used to generate sound patterns from the command line or
  111.    from within a batch file. Frequencies can be given on the command line or
  112.    read from a Script File.
  113.  
  114.    With Version 2.0 Sound Off! can now read and play "Real Music" script
  115.    files. Please see the MUSIC.DOC file for more on this.
  116.  
  117.    Various switches are provided for Turning off display messages, Running
  118.    an "Alarm", Turning off a "runaway" sound, Reading from script file.
  119.  
  120. SYSTEM REQUIREMENTS:
  121.  
  122.     Are few.  IBM PC/XT/AT or better, running Dos 3x and up.
  123.  
  124.               Video: Runs on mono or color. Color is reccomended.
  125.  
  126.               Disks: Will run on floppy system, but performance is slow
  127.                      for scripts.
  128.  
  129. COMMAND SYNTAX:  (Basic Required Variables)
  130.  
  131. SOUNDOFF [switch][scriptfile]<Start_Frequency><End_Frequency><Delay><Step>
  132.                                <AlarmNote1><AlarmNote2><Delay><Pause>
  133.  
  134.     Items in brackets [...] are optional, items in <...> are required.
  135.  
  136.     See examples for variables for Alarm Procedures. The Alarm
  137.     switches must be used.
  138.  
  139.     Examples will be provided shortly. For now lets explore these options
  140.     and parameters.
  141.  
  142.     The minimum needed for Sound Off! to work are the frequencies, the delay
  143.     factor, and the step factor.
  144.  
  145.     Frequencies will hereafter be reffered to as "notes".
  146.  
  147.      * Start_Freq: This is the first note to be played, anything below about
  148.        50 probably won't be heard unless you have a special speaker setup
  149.        for your PC.
  150.  
  151.      * End_Freq: This is the last note Sound Off! will play. After about
  152.        3000, the note again becomes hard to hear.
  153.  
  154.      * Delay: This is the time, in milliseconds, for Sound Off! to pause
  155.        between the playing of each note. There are aprox. 1000 milliseconds
  156.        to a second. I say aprox., because the PC timer is not as accurate as
  157.        a watch. If you specify 1000 for a delay, the delay will not likely
  158.        be an exact second.
  159.  
  160.      * Step: This specifies how big a jump Sound Off! should make between
  161.  
  162.   Make your PC "Come Alive" with Sounds and Music!!
  163.  
  164.  
  165. Sound Off!          Sound Generator - Program Documentation         Page  2
  166.  
  167.        notes. For instance, Start and End of 200 & 900 with a Step value of
  168.        50 will play the notes 200 250 300 350 400 450 500 550 600 650...900
  169.  
  170.     Experimentation with these values is the best teacher!
  171.  
  172.        To play a "tune" UP the scale make the Start_Frequency LESS
  173.        than the End_Frequency.
  174.  
  175.        Reverse this to play DOWN the scale, The Start_Frequency should
  176.        be GREATER than the End_Frequency.
  177.  
  178. DISPLAY:
  179.  
  180.     When Sound Off! runs, it will create a display of characters. One will
  181.     be written for each note played. The display is in color unless the
  182.     system is in MONO mode. This color display is NOT shown during
  183.     the playing of a script.
  184.  
  185.     At the end of the run, Sound Off! will display the command given to
  186.     produce the sounds you just heard, so you can write it down for future
  187.     use.
  188.  
  189.     If you do not want a display, see the '/S' switch below.
  190.  
  191.     While playing either a .SOS or .SOM script file, Sound Off! will
  192.     tell you which script it is playing, it will also display the
  193.     line number which it is currently playing from the script.
  194.  
  195.  
  196. SWITCHES:
  197.  
  198.      Switches may be upper or lower case. They must be proceeded by a
  199.      forward slash, ie: /f  and they must be seperated by a space, from any
  200.      other variable. Only one switch at a time is used. There are no
  201.      instances where more than one switch can be used.
  202.  
  203.   /f Instructs Sound Off! to read variables from a Sound scriptfile(.SOS).
  204.      The syntax is  SOUNDOFF /f filename. Program displays are active.
  205.      The script file is a simple Ascii text file and can be created by
  206.      any Ascii text file editor. You should give the scriptfile the extension
  207.      of .SOS This extension is REQUIRED!
  208.  /fs Runs the Sound script file with Displays turned off.
  209.      SOUNDOFF /fs filename
  210.  
  211.      Our program TFREQ (Ver 2.0) will create script files for Sound Off!
  212.  
  213.      When you specify the filename on the command line, do not included the
  214.      extension, it is assigned by Sound Off!  If the script file resides in a
  215.      directory that is included in your PATH statement, or in the current
  216.      directory then only the filename is needed.
  217.      If it does not then include a drive\dir\ with the filename.
  218.  
  219.      The script file must not include any alpha characters in the variable
  220.  
  221.   Make your PC "Come Alive" with Sounds and Music!!
  222.  
  223.  
  224. Sound Off!          Sound Generator - Program Documentation         Page  3
  225.  
  226.      lines. All variables must be numeric: from 0..9  Values must start in
  227.      the first column, and must have a space between them.
  228.      You can view the sample scripts included, but a small example is given
  229.      here.
  230.  
  231.      Sound Scripts use only one frequency and one delay per note,
  232.      no End_Freq or Step is used.
  233.  
  234.              Example Script:     400 50
  235.                                  640 10
  236.                                  330 25
  237.                                  440 50
  238.                                  550 200
  239.  
  240.       COMMENTS IN SOUND SCRIPTS:
  241.  
  242.       If you wish to add comments to the script, put a 0 (ZERO) for the
  243.       last frequency and delay, then insert comments after that. ie:
  244.  
  245.           400 50
  246.           .
  247.           .
  248.           .
  249.           550 200
  250.           0 0
  251.           Note: This is a test script for John.
  252.           eof filename.sos
  253.  
  254.        If you are careful, you can place comments to the right of the notes
  255.        and delays. Be sure to move to the right at least 3 or 4 spaces.
  256.  
  257.        You can write a letter after the variables, it doesn't matter. As long
  258.        as you remember to use a 0 for the last variables. If you don't, the
  259.        program will abort with an error.
  260.  
  261.   /s   The /S switch tells Sound Off! to run in "silent" mode. Program
  262.        messages or displays will not show. This is useful when using Sound
  263.        Off! in batch files. But.....error messages will still display.
  264.  
  265.        To run Sound Off! in silet mode just type as such:
  266.          SOUNDOFF /s 440 990 75 25
  267.  
  268.        You can use multiple Sound Off! commands in one batch file. Just put
  269.        each one on a seperate line. Look at the sample batch files included
  270.        for some examples.
  271.  
  272.   /m   Tells Sound Off! to play a Music Script File (.SOM).
  273.   /ms  Play Music Script File with NO display.
  274.        * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  275.        Please read MUSIC.DOC for all other information on using Music
  276.        Script Files.
  277.        * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  278.  
  279.  
  280.   Make your PC "Come Alive" with Sounds and Music!!
  281.  
  282.  
  283. Sound Off!          Sound Generator - Program Documentation         Page  4
  284.  
  285.   /a   Alarm mode.   SOUNDOFF /a 550 10 20  will start a constant beep, and
  286.        will continue until a key is pressed. You can use this to alert you of
  287.        when a process or program has finished.
  288.        The first is the frequency, then the length of the sound, then how
  289.        long to pause before playing the sound again.
  290.  
  291.  /a2   Calls the two tone alarm. Keypress aborts just as it does the
  292.        single tone alarm. For this one we have the following:
  293.        <1st Note> <2nd Note> <Delay> <Pause>
  294.  
  295.        See TEST_ALR.BAT for command syntax.
  296.  
  297.        You can enter any frequency,delay and pause you like. Again,
  298.        experimentation is the best way to discover what works for you.
  299.  
  300.   /k   Kill Sound.  If you happen to start Sound Off! with a missing value, be
  301.        it a frequency, a delay or what, you may find the program ending, with
  302.        the speaker still blaring out a note. Just type SOUNDOFF /k and the
  303.        racket will stop.
  304.  
  305.        This is also handy for programmers, I know I have forgotten to insert
  306.        code to stop the sound at times, while testing my programs. This way
  307.        you have a quick easy fix for that problem.
  308.  
  309. ERRORCODES:
  310.  
  311.        Please see the file ERRLVL.LST for a listing of error codes returned
  312.        by Sound Off!
  313.  
  314.  
  315. WHERE TO PUT IT:
  316.  
  317.        Sound Off! should be put in a directory that is included in your PATH
  318.        statement. This way it can be called from ANY directory on your drive.
  319.        If you do not know what the PATH statement is, please refer tou your
  320.        DOS manual. If you don't have a PATH statement, it's strongley
  321.        suggested that you implement it!!
  322.  
  323.        To save some typing, I suggest you put your script files in a
  324.        directory thats in your path. This way you only need include the
  325.        file name itself in the Sound Off! command.
  326.  
  327. SHAREWARE MESSAGE:
  328.  
  329.        Its unfortanate that I even have to do this, but I know for
  330.        a fact that there are copies out there, of my programs that
  331.        are being used without Registration. I don't feel that to be
  332.        fair. So......at the end of each and every call to Sound Off!
  333.        a one line message will flash for a bit, asking you
  334.        to Register your Shareware Programs, (including this one) :)
  335.  
  336.        This message WILL display, even if you turn off display via one
  337.        of the command switches. Again, Im sorry about this....but if
  338.  
  339.   Make your PC "Come Alive" with Sounds and Music!!
  340.  
  341.  
  342. Sound Off!          Sound Generator - Program Documentation         Page  5
  343.  
  344.        you Register the program, it will be   G...O...N...E!!
  345.  
  346.  
  347. REGISTRATION:
  348.  
  349.        If you find Sound Off! useful, and wish to continue its use, a
  350.        Registration of $12.00 is in order. Registration is a ONE TIME fee
  351.        and will get you a Registered Copy, free of any SHAREWARE notices,
  352.        full support for this and all future copies. Updates to the program
  353.        are at No Charge to Registered users.  Updates are supplied via
  354.        U.S. Mail or from our Support BBS (SOON!) Mail updates will require
  355.        a small fee to cover material and shipping.
  356.  
  357.        A registration form has been provided for you to use.
  358.        Please see REGCOM.DOC
  359.        I have other useful programs available also.
  360.        See PROGRAMS.TXT for a listing.
  361.  
  362.        If you program in Pascal you might be interested in my program
  363.        TFREQ which allows you to test sound procedures of many types, and
  364.        once you have what you want you can save it to a source file.
  365.        Source files are written in a Pascal procedue format for inclusion
  366.        in your programs.  We have a somewhat rough version out at present,
  367.        but Version 2.0 (major rewrite) is due out soon. This version will
  368.        also write script files for Sound Off!
  369.  
  370.  
  371. DISTRIBUTION:
  372.  
  373.        You may distribute Sound Off! with any programs or batch files
  374.        you create and give to others. The condition to this is: You must
  375.        distribute this documentation and all supporting files with it.
  376.        Not doing so will be considered an infringement of Federal
  377.        Copyright Law.  If you received the Original Zip file from
  378.        RaLin Enterprises, I ask that you distribute that same file.
  379.  
  380.        The above applies to only the SHAREWARE release version. The
  381.        REGISTERED version may NOT be distributed under any circumstances.
  382.  
  383. AUTHOR CONTACT:
  384.  
  385.            I can be reached by several means.
  386.  
  387.         Phone: (510) 651-0253 Ask for Rand
  388.           If you get my wife, or the answering machine, please leave your
  389.           name, number, and a brief description of the problem, and I will
  390.           get back to you ASAP! (See SUPPORT below)
  391.  
  392.         Net Mail:        1:215/777  or 1:161/42  Rand Nowell
  393.         Compuserve ID:   76124,761 (Checked 1-2 times a month, minimum)
  394.         Genie ID:        R.NOWELL  (Checked 1-2 times a month, minimum)
  395.         FIDO Net:        Shareware conference:  Rand Nowell
  396.         Mail:            Rand Nowell
  397.  
  398.   Make your PC "Come Alive" with Sounds and Music!!
  399.  
  400.  
  401. Sound Off!          Sound Generator - Program Documentation         Page  6
  402.  
  403.                          RaLin Enterprises
  404.                          49728 Sundale Dr.
  405.                          Fremont, Ca. 94538
  406.  
  407.  
  408.    SUPPORT:
  409.          Registered users receive full unlimited support, if I have to call
  410.          you back, it will be on my dime!
  411.          Unregistered users will receive help, but if I have to call, expect
  412.          a collect one.
  413.  
  414.          I am in the process of setting up a "part time" support BBS here,
  415.          you will be able to download my programs, and upgrade your current
  416.          Registered programs as upgrades become available. For the time
  417.          being this BBS will only run during certian hours, and be mostly
  418.          limited to having only RaLin programs available.
  419.  
  420.          It is hoped we can get a dedicated system configured for the BBS
  421.          before to long, and make MANY programs available.
  422.          Where is the time for all this?....................
  423.  
  424.          Registered users will be notified when the board is up!
  425.  
  426.    See the REGCOM.DOC file for our Registration plans.
  427.  
  428.    If you have any comments (good or bad) or suggestions, please use the
  429.    Comments/Suggestions form attached to the Registration.
  430.  
  431.    Thank You!
  432.  
  433.  
  434.  
  435. ACKNOWLEDGEMENTS:
  436.  
  437.    Sound Off! was written with Turbo Pascal
  438.    version 6.0, a product of Borland International.
  439.    A GREAT programming language!
  440.    Thanks Borland, for a job well done.
  441.  
  442.  
  443.    To those of you who Register, Thanks for helping support the
  444.    SHAREWARE CONCEPT! Registering this and other products, give the
  445.    authors incentive to continue enhancements and to develop new products
  446.    for your use.
  447.  
  448.  
  449.  
  450.    Make your PC "Come Alive" with Sounds and Music!!
  451.  
  452.